home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / bbslist1.zip / BBSLIST.DOC < prev    next >
Text File  |  1992-07-21  |  3KB  |  72 lines
  1.  
  2. Some help for installing the BBSLIST program:
  3. ---------------------------------------------
  4.  
  5. The program may be run from any directory and the config and data
  6. files may be located anywhere (even separately from each other,
  7. which seems silly).  The only argument you pass to the program is
  8. the filespec of the config file, i.e.:
  9.     \bbs-util\bbslist \bbs-util\bbslist.cfg
  10.  
  11. The config file is a text file which contains (line by line):
  12.     - The spec of the help file, which is file-attached to users
  13.     - The spec of the info file, which is file-attached to users
  14.     - The spec of the data file (indexed), which the program maintains
  15.     - The spec of the distribution list file (indexed), which the program maintains
  16.     - The spec for the output (text) bbs list
  17.     - The directory spec for your netmail directory (.MSG-style!)
  18.     - The spec of the header file to be prepended to the bbs listing
  19.     - The spec of the trailer file to be appended to the bbs listing
  20.     - The authorization password, which users include as the subject
  21.     - A debug string:  If 1st char is 'Y' then debug mode is on.
  22.                        If 2nd char is 'Y' then received messages are deleted.
  23.                        The other 6 characters are unused; don't use them!
  24.  
  25. The errorlevels returned by the program are:
  26.     #define ERRORLEVEL_SUCCESS       0
  27.     #define ERRORLEVEL_LIST_CHANGED  1
  28.     #define ERRORLEVEL_BAD_PARAMETER 2
  29.     #define ERRORLEVEL_CONFIGURATION 3
  30.     #define ERRORLEVEL_ENGINE        4
  31.     #define ERRORLEVEL_FATAL         5
  32.  
  33.     Whenever the program exits with the _ENGINE errorlevel, the source
  34.     of the error may be found in the accompanying file I_F_ENG.H.
  35.  
  36. If you don't want to support the distribution list function, or want to
  37. use the errorlevel returned by the program in conjunction with TICK or
  38. a similar program to send out updates, then simply place a line in the
  39. batch file which looks for and deletes the distribution data file if it
  40. exists.  The end result is that any distribution list entries added will
  41. exist only during the current program execution, then be deleted.
  42.  
  43. I imagine a batch file like so:
  44.     \bbs-util\bbslist.exe \bbs-util\bbslist.cfg >>\bbs-util\bbslist.log
  45.     if errorlevel 2  goto bbslist_error
  46.     if errorlevel 1  \tick\hatch etc. etc. etc....
  47.  
  48. Known bugs:
  49.     The header message should have a blank line at the end.
  50.  
  51.  
  52. ---------------------------------------------------------------------------
  53. Please direct comments, wish lists, and bug reports to:
  54.  
  55. Alton Moore
  56. Fidonet 1:397/5264 (NEC)
  57. WWIVnet 1@1042
  58.  
  59. ---------------------------------------------------------------------------
  60.  
  61. Update history:
  62.  
  63. Version 1.00 -- 06/01/92 -- Original
  64.         1.01 -- 06/29/92 -- Added info. file
  65.         1.02 -- 07/29/92 -- Added distribution list filespec and debug/delete
  66.                              flags to the configuration file (2 lines total).
  67.                              Program was rewritten to handle multiple functions
  68.                              per message (separated by a blank line) and
  69.                              generally just respond more cleanly.
  70.  
  71.  
  72.